Repository navigation
feat(projects): update projects and groups API to the latest docs - #430
Merged
Merged
Conversation
Projects: - add qaCheckActionAiPromptId, contextReviewAiPromptId, assignedStyleGuides and the `tagsDetection` key (ProjectRequest.tagDetection is kept as a deprecated alias); Enterprise: externalQaCheckIds, externalQaChecksIgnorable, custom fields, typed workflow step configs - Project.fields, ProjectSettings.externalQaChecksIgnorable and the new AI prompt ids; QaCheckCategories gains numbers, ai, outdated, mdx and unifiedPlaceholders; Project.isExternal is now read - deprecate assistActionAiPromptId, glossaryAccess and Project.background; wrongly typed Enterprise request fields get correctly typed replacements Groups: webUrl and savingsReportSettingsTemplateId; `filter` query param for listGroups/listProjects and `userId` for listProjects. File format settings: new Csv, Xlsx, Xliff, XliffTwo, StringCatalog, Vdf and Vsdx classes (extending OtherFileFormatSettings) and the missing fields of existing formats. Html/FmHtml `excludedElements` accepts both the documented array (excludedElementList) and the boolean returned by SDK 1.36.0, and is written the same way as before when only the legacy boolean is set. Strings exporter settings: missing Android/macOS/XLIFF fields, unknown formats no longer fail deserialization, and the JSON Patch request is available as editProjectStringsExporterSettingsWithPatch; the original editProjectStringsExporterSettings keeps its signature. Restore the Project.getFields() assertion in UsersApiExtendedTest. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
The excludedElements reader silently discarded any non-null value that was neither a boolean nor an array (e.g. a single string or an object) and turned object or array elements into empty strings. Such values now fail deserialization with a clear message instead of being lost, the same way SDK 1.36.0 failed on them. The documented array of strings (null elements allowed), the legacy boolean and null/missing values are read as before. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
andrii-bodnar
approved these changes
Nov 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Part of updating the SDK to the current Crowdin API docs, checked against the official OpenAPI specs (full YAML, all four editions). This PR covers Projects, Groups, file format settings and strings exporter settings. Compatible with the released SDK 1.37.0 (and 1.36.0;
projectsgroupsis identical in both): no public signature of the published 1.37.0 artifact is removed or changed.Changes
Projects
ProjectRequest/EnterpriseProjectRequest:qaCheckActionAiPromptId,contextReviewAiPromptId,assignedStyleGuides.externalQaCheckIds,externalQaChecksIgnorable,fields.configobject withassignees/assignedTeams,autoApproveOptionfor TM pre-translation, and a new AI pre-translate step.@Deprecated):ProjectRequest: the API key istagsDetection, nottagDetection. NewtagsDetectionfield;get/setTagDetectiondelegate to it.EnterpriseProjectRequest.exportStringsThatPassedWorkflowis sent as a boolean (exportStringsThatPassedWorkflowEnabled). The oldIntegersetter maps0→falseand anything else →true.EnterpriseProjectRequest.inContextPseudoLanguageIdis sent as a string language id (inContextPseudoLanguageIdValue). The oldBooleanfield is no longer sent; it was never a valid value.Project.fields.ProjectSettings:qaCheckActionAiPromptId,contextReviewAiPromptId,assignedStyleGuides,externalQaChecksIgnorable.QaCheckCategories:numbers,ai,outdated,mdx,unifiedPlaceholders.Project.isExternalis now actually read; it was alwaysfalsebefore.assistActionAiPromptId(not in the API),glossaryAccess(useglossaryAccessOption),Project.background, and the step-levelassigneesof the translate/proofread workflow step.preTranslationAiPromptId. The API marks it deprecated, and it isn't in 1.36.0 or 1.37.0.Groups
Group.webUrlandsavingsReportSettingsTemplateId;AddGroupRequest.savingsReportSettingsTemplateId.filterquery parameter forlistGroups/listProjects, anduserIdforlistProjects(Crowdin). All are left out of the URL whennull.File format settings
OtherFileFormatSettings, so existinginstanceof OtherFileFormatSettingschecks keep working.customSegmentation,inlineTags,hideAttributeValues, AdocexcludeIncludeDirectives, IdmlinlineHyperlinkText, the Markdown/MDX marker options, and the Docx options.excludedElements(HTML and front-matter HTML): the docs describe an array of CSS selectors, while SDK 1.36.0 modelled a boolean. Both are now supported:excludedElementList(nullelements allowed); a boolean goes to the existingexcludedElements;nullor a missing key leaves bothnull. Any other shape (a single string, a number, an object, or an array with non-string elements) fails deserialization with a clearexcludedElementsmessage instead of being silently dropped. 1.36.0 also failed on these.excludedElementListis set; otherwise the legacy boolean is sent, as in 1.36.0 (approved).getExcludedElements()/setExcludedElements(Boolean)are unchanged; the boolean field is@Deprecatedin favour ofexcludedElementList.Strings exporter settings
convertLineBreaks,useCdataForStringsWithTags; macOSconvertLineBreaks,exportContext; XLIFFcopySourceToEmptyTarget,exportTranslatorsComment.formatin a response returns the baseStringsExporterSettingsinstead of throwing.editProjectStringsExporterSettingsWithPatch(projectId, settingsId, List<PatchRequest>)sends the documented JSON Patch body. The originaleditProjectStringsExporterSettings(…, StringsExporterSettingsRequest)keeps its signature and behaviour and is@Deprecated. The new method has its own name, soeditProjectStringsExporterSettings(id, id, null)still compiles.Tests
ExcludedElementsSerializationTest(6 tests, realJacksonJsonTransformer). It covers the boolean, array, empty array,nullelements,nulland missing values, and rejection of 8 unexpected shapes, both directly and throughFileFormatSettingsResource(the polymorphic deserializer path), plus request serialization (array priority, legacy boolean) and round trips.editProjectStringsExporterSettingsWithNullRequestCompatibilityTest: the original call with a literalnullcompiles and reaches the endpoint.project.getFields()assertion inUsersApiExtendedTest, which was removed in feat(users,teams): update users and teams API to the latest docs #420 becauseProject.fieldsarrives with this PR. The fixture'sproject.fieldsmatches the documentedEnterpriseAdditionalFields.ProjectsGroupsApiExtendedTest,ProjectFileFormatSettingsExtendedTestandProjectStringsExporterSettingsExtendedTest.Backward compatibility
Apiclass.tagDetectionis sent astagsDetection.exportStringsThatPassedWorkflowis sent as a boolean.Boolean inContextPseudoLanguageIdis no longer sent.OtherFileFormatSettings.equals/hashCode/toStringinclude the new fields.Validation
./gradlew build): 742 tests, 0 failures, on both JDK 17 and JDK 8.ProjectsGroupsApi, both on methods unchanged since 1.36.0; one of the three warnings 1.36.0 had in this file is now fixed.Unverified or inferred contracts
formatcodes the deserializer uses for CSV, XLSX, XLIFF, VDF and VSDX (csv,xlsx,xliff,vdf,vsdx) are inferred. The spec typesformatas a free string. XLIFF 2.0 and String Catalog aren't mapped on read (String Catalog has no response schema). Unknown codes fall back toOtherFileFormatSettings.excludedElementsin responses: it isn't listed in the HTML response schemas. Accepting a boolean is based on SDK 1.36.0, not on the docs. Unexpected shapes are rejected rather than dropped.XliffStringsExporterSettings.languagePairMappingis unchanged. The spec contradicts itself (the schema says{lang: {sourceLanguageId}}, the example says{"uk": "es"}), and the existingMap<String, String>fails on the schema shape. This is an existing issue, not touched here.PATCH /projects/{projectId}: the docs show the response without the usualdatawrapper. The SDK behaviour is unchanged since 1.36.0.Review decisions (approved)
excludedElementsis still sent when onlysetExcludedElements(Boolean)is used, for 1.36.0 compatibility. The documented array takes priority whenexcludedElementListis set.editProjectStringsExporterSettingsWithPatch.🤖 Generated with Claude Code